Skip to content

Conversation

@mbaldessari
Copy link
Contributor

  • Add a yaml-flattening ruby script
  • Add central metadata doc workflow
  • Add an initial cluster sizing template
  • Add an example of how CI would generate metadata file
  • Add examples

This will transform a yaml like this one:
    metadata_version: "1.0"
    name: industrial-edge
    pattern_version: "2.0"
    display_name: Industrial Edge
    repo_url: https://github.com/mbaldessari/industrial-edge
    docs_repo_url: https://github.com/mbaldessari/docs
    issues_url: https://github.com/validatedpatterns/industrial-edge/issues
    docs_url: https://validatedpatterns.io/patterns/industrial-edge/
    ci_url: https://validatedpatterns.io/ci/?pattern=industrialedge
    tier: tested
    owners: mbaldessari, darkdoc
    requirements:
      hub: # Main cluster
        compute:
          platform:
            gcp:
              replicas: 5
              type: n1-standard-16
            azure:
              replicas: 5
              type: Standard_D16s_v5
            aws:
              replicas: 4
              type: m5.4xlarge
        controlPlane:
          platform:
            gcp:
              replicas: 3
              type: n1-standard-16
            azure:
              replicas: 3
              type: Standard_D16s_v3
            aws:
              replicas: 3
              type: m5.4xlarge
      spoke: # optional - represents the clusters imported into ACM
        compute:
          platform:
            gcp:
              replicas: 3
              type: n1-standard-16
            azure:
              replicas: 3
              type: Standard_D16s_v5
            aws:
              replicas: 3
              type: m5.2xlarge
        controlPlane:
          platform:
            gcp:
              replicas: 3
              type: n1-standard-16
            azure:
              replicas: 3
              type: Standard_D16s_v5
            aws:
              replicas: 3
              type: m5.2xlarge
    extra_features:
      hypershift_support: false
      spoke_support: true

    external_requirements:

To this:

    :metadata_version: 1.0
    :name: industrial-edge
    :pattern_version: 2.0
    :display_name: Industrial Edge
    :repo_url: https://github.com/mbaldessari/industrial-edge
    :docs_repo_url: https://github.com/mbaldessari/docs
    :issues_url: https://github.com/validatedpatterns/industrial-edge/issues
    :docs_url: https://validatedpatterns.io/patterns/industrial-edge/
    :ci_url: https://validatedpatterns.io/ci/?pattern=industrialedge
    :tier: tested
    :owners: mbaldessari, darkdoc
    :requirements_hub_compute_platform_gcp_replicas: 5
    :requirements_hub_compute_platform_gcp_type: n1-standard-16
    :requirements_hub_compute_platform_azure_replicas: 5
    :requirements_hub_compute_platform_azure_type: Standard_D16s_v5
    :requirements_hub_compute_platform_aws_replicas: 4
    :requirements_hub_compute_platform_aws_type: m5.4xlarge
    :requirements_hub_controlPlane_platform_gcp_replicas: 3
    :requirements_hub_controlPlane_platform_gcp_type: n1-standard-16
    :requirements_hub_controlPlane_platform_azure_replicas: 3
    :requirements_hub_controlPlane_platform_azure_type: Standard_D16s_v3
    :requirements_hub_controlPlane_platform_aws_replicas: 3
    :requirements_hub_controlPlane_platform_aws_type: m5.4xlarge
    :requirements_spoke_compute_platform_gcp_replicas: 3
    :requirements_spoke_compute_platform_gcp_type: n1-standard-16
    :requirements_spoke_compute_platform_azure_replicas: 3
    :requirements_spoke_compute_platform_azure_type: Standard_D16s_v5
    :requirements_spoke_compute_platform_aws_replicas: 3
    :requirements_spoke_compute_platform_aws_type: m5.2xlarge
    :requirements_spoke_controlPlane_platform_gcp_replicas: 3
    :requirements_spoke_controlPlane_platform_gcp_type: n1-standard-16
    :requirements_spoke_controlPlane_platform_azure_replicas: 3
    :requirements_spoke_controlPlane_platform_azure_type: Standard_D16s_v5
    :requirements_spoke_controlPlane_platform_aws_replicas: 3
    :requirements_spoke_controlPlane_platform_aws_type: m5.2xlarge
    :extra_features_hypershift_support: false
    :extra_features_spoke_support: true
    :external_requirements:

This will allow us to consume this metadata information from asciidoc.
This will be regenerated in the future by the pattern (in this case IE)
GH action itself.
@mbaldessari
Copy link
Contributor Author

This is an automated message:

You can preview this docs PR at http://519.docs-pr.validatedpatterns.io
Note that they get generated every five minutes, so please wait a bit.

@openshift-ci openshift-ci bot added the size/L label Jan 29, 2025
@mbaldessari mbaldessari merged commit 0bfadb5 into validatedpatterns:main Jan 30, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant